Within expressions, the software’s reporting tools, and Data Feed Out profiles, you can reference fields to return their values.
These fields are individual data elements—like columns in a table—that describe:
Scheduling information (e.g., task start/finish times, period IDs)
Geological and operational data (e.g., volume, density, haulage metrics)
Resource and productivity metrics (e.g., fuel consumed, production rate)
Spatial data (e.g., polygons, surfaces in WKT format)
These fields are generated by the system and can be used to build custom reports, charts, and data exports.
You can include reports fields in pivot tables and charts (refer to Reporting tab), and custom Gantt reports (refer to Gantt Reporting tab).
For example, a closing balance stockpile report could evaluate the Mass of each Material sent to a Location (specific stockpile or dump) at the end of each Period.
Report expressions are logic-based formulas used within the reporting tools to enhance, filter, or customise report outputs. They allow users to:
They can:
Filter the data in an entire report or field of the report. (For example, to include a record in the report, its Activity field must equal Mining)
Map custom fields to values by referencing the values of report fields.
Depending on the context and the expression, some of these fields might appear with different names. In this case, their original name appears in parentheses.
Data Feed Out allows you to publish schedule data to EPF servers using profiles. Each profile includes a list of records and a set of definition fields, which are calculated using expressions. These expression can reference report fields to derive the values dynamically.
Data Feed Out allows you to publish schedule data to EPF servers using profiles.
For example, the Volume data feed could simply pull the value from the Volume report field. The VolumeAdjusted data field could use the Volume * 1.1 field to apply a swell factor.
The report fields you can reference in a data feed out field depend on the data type and field type.
Data type: Defines the kind of data stored: Text, Numeric, or Date.
Field type: Defines the role of the field in the data structure:
Key: Uniquely identifies a record or links it to other data (e.g, PeriodID, ActivityArea).
Field: Contains measurable or descriptive data (e.g., Fuel Consumed, Cycle Time)
Key/Field: Serves both purposes (e.g., TaskStart).
The full list of report fields is provided below. For each field, the table specifies the types of reports in which the field is available. Additionally, for use in Data Feed Out profiles, it indicates the required data type and field type needed to reference the field correctly.
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Finish (Period Finish) |
Schedule Results/ Schedule Report |
Date |
Key |
Date and Time fields for the scheduling period finish. |
|
Start (Period Start) |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Date |
Key |
Date and Time fields for the scheduling period start. |
|
Period Id |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Text |
Key |
Concatenated YYYYMMDD Period Name. |
|
Period Name |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Text |
Key |
The name of the period. |
|
Period Number |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Numeric |
Key |
The period number. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Start |
Schedule Results/ Schedule Report |
Date |
Key/Field |
Date and Time fields for the task start. |
|
Finish |
Schedule Results/ Schedule Report |
Date |
Key/Field |
Date and Time fields for the task finish. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Cycle Distance |
Schedule Results/ Schedule Report |
Numeric |
Field |
The source to destination and return haulage distance (the odometer distance) in site configured units. |
|
Cycle Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
Reported in decimal minutes the spot time at loader + Load time + Travel time(full) + Spot time at dump + Dump time + Travel time (empty). |
|
Dump Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
User-entered time to dump truck in minutes. |
|
Electricity Consumed (kWh) |
Schedule Results/ Schedule Report |
Numeric |
Field |
The nett electrical energy consumed by the truck in its respective scheduling step. |
|
Equivalent Flat Haulage Distance |
Schedule Results/ Schedule Report |
Numeric |
Field |
A truck’s speed typically alternates when the truck travels between flat roads and non-flat roads. Factors like rolling resistance and traction coefficient, and speed limits on roads of specific grades, control the truck’s speed. Equivalent Flat Haul (EFL) is a way of comparing different haul routes with each other and roughly estimating trucking requirements. For the given route, EFL determines the length of the route is the route was completely flat (how far the truck would have moved if the earth was flat). To report the EFH, for the given scheduling step, the software back-calculates the flat haulage distance that would result in the same travel time as the non-flat haulage distance. This process generates a curve that compares the total travel time (source to destination, travelling with a full load and returning with an empty load). The process then interpolates the EFH from the given scheduling step’s haul route. |
|
Equivalent Flat Haul (Alt.) |
Schedule Results/ Schedule Report |
Numeric |
Field |
The alternate Equivalent Flat Haul (alternate EFH) uses a different method to calculate the EFH (described above). For the given scheduling step, the software calculates the EFH based on the horizontal distance associated with the optimal one-way haulage route from the source to the destination (with a full load). The software applies adjustments to the calculation to account for uphill and downhill components of the one-way haul route. |
|
Forward Distance |
Schedule Results /Schedule Report |
Numeric |
Field |
The one-way haul distance of the forward haulage route, that is, source to destination odometer distance in site configured units. |
|
Forward Haulage Maximum Elevation |
Schedule Results /Schedule Report |
Numeric |
Field |
The maximum z-coordinate value of the forward haul profile. |
|
Forward Haulage Minimum Elevation |
Schedule Results /Schedule Report |
Numeric |
Field |
The minimum z-coordinate value of the forward haul profile. |
|
Forward Haulage Negative Elevation Change |
Schedule Results /Schedule Report |
Numeric |
Field |
The sum of the negative elevation changes of the forward haul profile. |
|
Forward Haulage Positive Elevation Change |
Schedule Results /Schedule Report |
Numeric |
Field |
The sum of the positive elevation changes of the forward haul profile. |
|
Forward Haulage Travel Time |
Schedule Results /Schedule Report |
Numeric |
Field |
The haulage travel time in the forward direction (hauling a load). This value, alongside the Reverse Haulage Travel Time value, adds up to the Travel Time value. |
|
Fuel Consumed |
Schedule Results /Schedule Report |
Numeric |
Field |
The fuel consumed for the principal truck over the scheduling step. Fuel consumption accounts for fuel used during load time, the travel time, and the dump time. |
|
Maximum Tyre Workload (TKPH) |
Schedule Results /Schedule Report |
Numeric |
Field |
Tyre Kilometre per Hour (TKPH), a measure of tyre workload generated over the forward (loaded) and reverse (unloaded) distance for the scheduling step. TKPH includes the dump and load times which will have the effect of reducing tyre workloads (that is, tyre cools while stationary). |
|
Load Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
User-entered time to load truck in minutes. |
|
Number of Trucks |
Schedule Results/ Schedule Report |
Numeric |
Field |
Truck Hours / (Hours per Truck per Period). |
|
Reverse Distance |
Schedule Results/ Schedule Report |
Numeric |
Field |
The one-way haul distance for the empty truck. Destination to source odometer distance. |
|
Reverse Haulage Maximum Elevation |
Schedule Results /Schedule Report |
Numeric |
Field |
The maximum z-coordinate value of the reverse haul profile. |
|
Reverse Haulage Minimum Elevation |
Schedule Results /Schedule Report |
Numeric |
Field |
The minimum z-coordinate value of the reverse haul profile. |
|
Reverse Haulage Negative Elevation Change |
Schedule Results /Schedule Report |
Numeric |
Field |
The sum of the negative elevation changes of the reverse haul profile. |
|
Reverse Haulage Positive Elevation Change |
Schedule Results /Schedule Report |
Numeric |
Field |
The sum of the positive elevation changes of the reverse haul profile. |
|
Reverse Haulage Travel Time |
Schedule Results /Schedule Report |
Numeric |
Field |
The haulage travel time in the reverse direction (with an empty load). This value, alongside the Forward Haulage Travel Time value, adds up to the Travel Time value. |
|
Spot Time at Dump |
Schedule Results/ Schedule Report |
Numeric |
Field |
User entered time to spot at dump in minutes. |
|
Spot Time at Loader |
Schedule Results/ Schedule Report |
Numeric |
Field |
User-entered time to spot at loader in minutes. |
|
Travel Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
Travel time in minutes using the quickest path method. The time is calculated as per HAULSIM and adjusted by the expression set in Config > Haulage. |
|
Truck Capacity |
Schedule Results/ Schedule Report |
Numeric |
Field |
Mass / (Truck Payload / (Cycle Time / 60)). |
|
Field Name |
Available In |
Data Type |
Field Type |
Expression |
|---|---|---|---|---|
|
Activity |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Key |
The activity definition name. |
|
Activity Area |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Key |
The activity area name. |
|
Activity Area Note |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
The note associated with the activity area. |
|
Activity Area Spatial Domain |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
The Spatial Domain associated with the activity area. |
|
Destination Name |
Schedule Results/ Schedule Report |
Text |
Key |
Material flow destination node name. |
|
Destination Type |
Schedule Results/ Schedule Report |
Text |
Key |
Material flow node type. |
|
Dump Block |
Schedule Results/ Schedule Report |
Text |
Key |
The dump block name. |
|
Dump Lift |
Schedule Results/ Schedule Report |
Text |
Key |
The dump lift name. |
|
Is Resource Assigned |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Key |
The activity area name. |
|
Material |
Schedule Results Publish Activity Areas |
Text |
Key |
Material types of the moved material. |
|
Material Movement |
Schedule Results/ Schedule Report Publish Activity Area |
Text |
Key |
True if material moves from source to destination. |
|
Mining Level Name |
Schedule Results Publish Activity Areas Design Request/ |
Text |
Key |
Mining level name if material is mined from activity area. |
|
Pit Name |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Key |
Name of the pit for the source record (activity area). |
|
Resource Name |
Schedule Results/ Schedule Report |
Text |
Key |
Name of resource instance associated with the record's activity type. |
|
Resource Type |
Schedule Results/ Schedule Report |
Text |
Key |
Name of resource type associated with the record's activity type. |
|
Slice |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report |
Numeric |
Key |
The activity area slice number (each slice is treated as a reserved record). |
|
Source |
Schedule Results/ Schedule Report |
Text |
Key |
The material flow source node name. |
|
Source Type |
Schedule Results/ Schedule Report |
Text |
Key |
The material flow source mode type. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Destination Build |
Schedule Results/ Schedule Report |
Text |
Key |
The build name of the material flow destination. |
|
Destination Parcel |
Schedule Results/ Schedule Report |
Text |
Key |
The parcel name of the material flow destination. |
|
Destination Pile |
Schedule Results/ Schedule Report |
Text |
Key |
The pile name of the material flow destination. |
|
Source Build |
Schedule Results/ Schedule Report |
Text |
Key |
The build name of the material flow source. |
|
Source Parcel |
Schedule Results/ Schedule Report |
Text |
Key |
The parcel name of the material flow source. |
|
Source Pile |
Schedule Results/ Schedule Report |
Text |
Key |
The pile name of the material flow source. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Dump Block |
Storage Locations/ Closing Balance Report |
Text |
Key |
The dump block name of the current location. |
|
Dump Lift |
Storage Locations/ Closing Balance Report |
Text |
Key |
The dump lift name of the current location. |
|
Location |
Storage Locations/ Closing Balance Report |
Text |
Key |
The current location name. |
|
Location Type |
Storage Locations/ Closing Balance Report |
Text |
Key |
The location node type. |
|
Material |
Storage Locations/ Closing Balance Report |
Text |
Key |
The material name. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Build |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Text |
Key |
The build name of the current location (staged stockpile node). |
|
Pile |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Text |
Key |
The pile name of the current location (staged stockpile node). |
|
Pile State |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Text |
Key |
The building and depleting phase of the pile for a period. |
|
Dump Block |
Storage Locations/ Closing Balance Report |
Text |
Key |
The dump block name of the current location. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Activity Area Floor Polygon |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Activity Area floor polygon in WKT format POLYGON Z ((x1 y1 z1,x2 y2 z2,...xn yn zn)). |
|
Activity Area Floor Polygon - as designed |
Schedule Results/ Schedule Report Publish Activity Areas Design Request/ |
Text |
Field |
Activity Area floor (silhouette) polygon in WKT format. |
|
Activity Area Floor Surface |
Schedule Results/ Schedule Report Publish Activity Areas Design Request/ |
Text |
Field |
Activity Area floor surface in WKT format (TIN) TIN (((x1 y1 z1,x2 y2 z2,x3 y3 z3,x1 y1 z1)),...). |
|
Activity Area Floor Surface - with radius |
Schedule Results/ Schedule Report Publish Activity Areas Design Request/ |
Text |
Field |
Activity Area floor surface with a specified buffer (radius) applied, in WKT format (TIN). |
|
Activity Area Roof Polygon |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Activity Area roof polygon in WKT format. |
|
Activity Area Roof Surface |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Activity Area roof surface in WKT format (TIN). |
|
Activity Area Solid |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Activity Area solid in WKT format (TIN). |
|
Period Floor Polygon |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Period portion of area floor polygon in WKT format. |
|
Period Floor Surface |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Period portion of area floor surface in WKT format (TIN). |
|
Period Roof Polygon |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Period portion of area roof polygon in WKT format. |
|
Period Roof Surface |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Design Request/ |
Text |
Field |
Period portion of area roof surface in WKT format (TIN). |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Avg Flr Elevation |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The average elevation (of each point) of the floor of the activity area. |
|
Avg Tk |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The average thickness of the activity area (Volume / Plan Area). |
|
Density |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The density of the activity area. |
|
Grade Control Intersection Percent |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The percentage of the activity area solid that intersects with grade control blocks (if imported). |
|
Mass |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The mass of the activity area (Volume * Density). |
|
Plan Area |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The surface area of the activity area. |
|
Volume |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The volume of the activity area. |
|
Volume_Swollen |
Schedule Results/ Schedule Report Activity Areas/ Activity Area Report Storage Locations/ Closing Balance Report Design Request/ |
Numeric |
Field |
The volume of the activity area with the swell factor applied. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
Activity Area Rate Factor |
Schedule Results/ Schedule Report |
Numeric |
Field |
The production rate factor applied to a given activity area. This factor modifies the production rate of any resource operating within that area by the specified amount. Defined in Activity Areas tab. |
|
Activity Quantity |
Schedule Results/ Schedule Report |
Numeric |
Field |
The aggregated quantity of the activity quantity field. |
|
Activity Quantity Unit |
Schedule Results/ Schedule Report |
Text |
Key |
The units of the activity quantity field. |
|
Available Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
Available roster time for the reported period. |
|
Delay Details |
Schedule Results/ Schedule Report |
Text |
Key |
The maintenance order number. |
|
Duration |
Schedule Results/ Schedule Report |
Numeric |
Field |
Resource productive time. |
|
Is Available |
Schedule Results/ Schedule Report |
Text |
Key |
Flag to indicate whether the resource is in maintenance. |
|
Is Operating |
Schedule Results/ Schedule Report |
Text |
Key |
Flag to indicate whether the resource is operating (productive activity or travelling). |
|
Is Productive |
Schedule Results/ Schedule Report |
Text |
Key |
Flag to indicate whether the resource is productive (productive activity). |
|
Non Production Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
Sum of work category periods excluding 'Available' roster time for a Resource for a reporting period. |
|
Operating Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
The amount of time a resource can operate. It’s determined by this formula: Rostered Hours × Resourse Effective Utilisation |
|
Resource Period Value |
Schedule Results/ Schedule Report |
Numeric.
|
Field |
The resource’s value of ResourcePeriodValue for the given period. Defined in Site Config > Resources (Production Rates), this represents a value that helps set the resource’s production rate for the given period. |
|
Production Rate (Actual) |
Schedule Results/ Schedule Report |
Numeric |
Field |
The actual production rate used by a resource on an activity area. It’s determined by this formula: Entered Production Rate * Resource Effective Utilisation Refer to Site Config > Resources (Production Rates). |
|
Production Rate (Entered) |
Schedule Results/ Schedule Report |
Numeric |
Field |
The resource's production rate, after considering the site-specific production rate, the periodic rate factor, and the activity area rate factor (if defined). This rate is used to determine the actual production rate achieved by the resource. Refer to Site Config > Resources (Production Rates). |
|
Production Rate (Nominal) |
Schedule Results/ Schedule Report |
Numeric |
Field |
The base/global rate of the resource, unaffected by any modifiers or site-specific production rates Refer to Site Config > Resources (Production Rates). |
|
Production Rate Factor |
Schedule Results/ Schedule Report |
Numeric |
Field |
A factor, representing a percentage of the resource’s actual production rate, specifying how much of the actual production rate is used. Depending on your setup, the software can dynamically reduce a resource’s production rate to achieve objectives. Refer to Site Config > General and Calendar Settings. |
|
Production Rate Unit |
Schedule Results/ Schedule Report |
Text |
Key |
The activity area resource productive rate unit. |
|
Productive Activity Quantity |
Schedule Results/ Schedule Report |
Numeric |
Field |
The aggregated quantity for productive tasks. |
|
Productive Activity Quantity Unit |
Schedule Results/ Schedule Report |
Text |
Key |
The unit of the activity quantity field for productive tasks. |
|
Productive Time |
Schedule Results/ Schedule Report |
Numeric |
Field |
Sum of productive time for a resource. |
|
Resource Availability |
Schedule Results/ Schedule Report |
Numeric |
Field |
The percentage of rostered time the resource is available for use (Client > Resources tab). This percentage is weight averaged by the task duration. |
|
Resource Effective Utilisation |
Schedule Results/ Schedule Report |
Numeric |
Field |
The total percentage of rostered time that the resource is being utilised for the given task. This is a multiplication of the resource’s Availability, Utilisation, and Efficiency values(Client > Resources tab). |
|
Resource Efficiency |
Schedule Results/ Schedule Report |
Numeric |
Field |
The percentage of time that reflects how effectively the resource performs when in use (Client > Resources tab). This percentage is weight averaged by the task duration, multiplied by the resource Availability and Utilisation. |
|
Resource Rate Factor |
Schedule Results/ Schedule Report |
Numeric |
Field |
A factor that represents a percentage of the resource’s nominal production rate – that will actually be used by the resource in the given period. Refer to Site Config > Resources tab. |
|
Resource Utilisation |
Schedule Results/ Schedule Report |
Numeric |
Field |
The percentage of available time that the resource is being used (Client > Resources tab). This percentage is weight averaged by the task duration multiplied by the resource Availability. |
|
Field Name |
Available In |
Data Type |
Field Type |
Description |
|---|---|---|---|---|
|
ProductMass |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Numeric |
Field |
The mass (t) of the washed coal product. |
|
Wash Plant Cut-Point |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Numeric |
Field |
The specific gravity at which the coal feed sinks within the washing unit. |
|
Wash Plant Yield |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Numeric |
Field |
The yield of the wash plant at the specified ash content. |
|
Product<quality> |
Schedule Results/ Schedule Report Storage Locations/ Closing Balance Report |
Numeric |
Field |
The wash coal product quality value. |
|
Constants |
Description |
Example |
|---|---|---|
|
TRUE |
Represents the Boolean True value. |
|
|
FALSE |
Represents the Boolean False value. |
|
|
? |
Represents a null reference that does not refer to any object. |
Iif( [Source] != ?,… |
|
Operators |
Description |
Example |
|---|---|---|
|
+ |
Adds the value of one numeric expression to another or concatenates two strings. |
[Activity Quantity] + 40 |
|
[Activity Area ] + '-' + [Resource Name] |
|
|
|
- |
Finds the difference between two numbers. |
[Production Rate (Nominal)] - [Production Rate (Actual)] |
|
* |
Multiplies the value of two expressions. |
[Activity Quantity] * [Production Rate (Actual)] |
|
/ |
Divides the first operand by the second. |
[Activity Quantity] / 2 |
|
% |
Returns the remainder (modulus) obtained by dividing one numeric expression by another. |
[Activity Quantity] % 3 |
|
| |
Performs a bitwise inclusive OR on two numeric expressions. Compares each bit of its first operand to the corresponding bit of its second operand. If either bit is 1, the corresponding resulting bit is set to 1. Otherwise, the corresponding resulting bit is set to 0. |
[Number] | [Number] |
|
& |
The bitwise AND operator. Compares each bit of its first operand to the corresponding bit of its second operand. If both bits are 1, the corresponding resulting bit is set to 1. Otherwise, the corresponding resulting bit is set to 0. |
[Number] & 10 |
|
^ |
Performs a bitwise exclusive OR on two numeric expressions. |
[Number] ^ [Number] |
|
== |
Returns true if both operands have the same value; otherwise, it returns false. |
[Task Start Hour] == 10 |
|
!= |
Returns true if the operands do not have the same value; otherwise, it returns false. |
[Task Start Hour] != 10 |
|
< |
Less than operator. Used to compare expressions. |
[Activity Quantity] < 200 |
|
<= |
Less than or equal to operator. Used to compare expressions. |
[Activity Quantity] <= 200 |
|
>= |
Greater than or equal to operator. Used to compare expressions. |
[Activity Quantity] >= 300 |
|
> |
Greater than operator. Used to compare expressions. |
[Activity Quantity] > 300 |
|
In (,,,) |
Tests for the existence of a property in an object. |
[Pit Name] In ('West', 'East', 'North') |
|
Between (,) |
Specifies a range to test. Returns true if a value is greater than or equal to the first operand and less than or equal to the second operand. |
[Production Rate (Actual)] Between (10, 20) |
|
And |
Performs a logical conjunction on two Boolean expressions. |
[Is Available] == 'Yes' And ([Production Rate (Actual)] > 1000 |
|
Or |
Performs a logical disjunction on two Boolean expressions. |
[Is Available] == 'Yes' And ([Production Rate (Actual)] > 1000) |
|
Not |
Performs a logical negation on a Boolean expression. |
Not ([Is Available] == 'Yes') |
|
Aggregate Functions |
Description |
Example |
|---|---|---|
|
Avg |
Evaluates the average of the values in the collection. |
Avg([Density]) |
|
Count |
Returns the number of objects in a collection. (Field type integer) |
[][[Density] < 2.1].Count() |
|
Exists |
Determines whether the object exists in the collection. (Field type boolean) |
[][[Density] < 2.1].Exists() |
|
Max |
Returns the maximum expression value in a collection. |
Max([Density]) |
|
Min |
Returns the minimum expression value in a collection. |
Min([Density]) |
|
Single |
Returns a single object from the collection. |
TODO |
|
Sum |
Returns the sum of all the expression values in the collection. |
Sum([Activity Quantity]) |
|
Datetime Functions |
Description |
Example |
|---|---|---|
|
AddDays(DateTime, DaysCount) |
Returns a date-time value that is the specified number of days from the specified DateTime. |
AddDays([Period Finish], 30) |
|
AddHours(DateTime, HoursCount) |
Returns a date-time value that is the specified number of hours from the specified DateTime. |
AddHours([Period Start], 2) |
|
AddMilliSeconds(DateTime, MilliSecondsCount) |
Returns a date-time value that is the specified number of milliseconds from the specified DateTime. |
AddMilliSeconds(([Period Start], 5000)) |
|
AddMinutes(DateTime, MinutesCount) |
Returns a date-time value that is the specified number of minutes from the specified DateTime. |
AddMinutes([Period Start], 30) |
|
AddMonths(DateTime, MonthsCount) |
Returns a date-time value that is the specified number of months from the specified DateTime. |
AddMonths([Period Finish], 1) |
|
AddSeconds(DateTime, SecondsCount) |
Returns a date-time value that is the specified number of seconds from the specified DateTime. |
AddSeconds([Period Start], 60) |
|
AddTicks(DateTime, TicksCount) |
Returns a date-time value that is the specified number of ticks from the specified DateTime. |
AddTicks([Period Start], 5000) |
|
AddTimeSpan(DateTime, TimeSpan) |
Returns a date-time value that is from the specified DateTime for the given TimeSpan. |
AddTimeSpan([Period Start], [Duration]) |
|
AddYears(DateTime, YearsCount) |
Returns a date-time value that is the specified number of years from the specified DateTime. |
AddYears([Period Finish], -1) |
|
DateDiffDay(startDate, endDate) |
Returns the number of day boundaries between two non-nullable dates. |
DateDiffDay([Period Start], Now()) |
|
DateDiffHour(startDate, endDate) |
Returns the number of hour boundaries between two non-nullable dates. |
DateDiffHour([Period Start], Now()) |
|
DateDiffMilliSecond(startDate, endDate) |
Returns the number of millisecond boundaries between two non-nullable dates. |
DateDiffMilliSecond([Period Start], Now()) |
|
DateDiffMinute(startDate, endDate) |
Returns the number of minute boundaries between two non-nullable dates. |
DateDiffMinute([Period Start], Now()) |
|
DateDiffMonth(startDate, endDate) |
Returns the number of month boundaries between two non-nullable dates. |
DateDiffMonth([Period Start], Now()) |
|
DateDiffSecond(startDate, endDate) |
Returns the number of second boundaries between two non-nullable dates. |
DateDiffSecond([Period Start], Now()) |
|
DateDiffTick(startDate, endDate) |
Returns the number of tick boundaries between two non-nullable dates. |
DateDiffTick([Task Start], Now()) |
|
DateDiffYear(startDate, endDate) |
Returns the number of year boundaries between two non-nullable dates. |
DateDiffYear([Period Start], Now()) |
|
GetDate(DateTime) |
Extracts a date from the defined DateTime. |
GetDate([Period Finish]) |
|
GetDay(DateTime) |
Extracts a day from the defined DateTime. |
GetDay([Period Finish]) |
|
GetDayOfWeek(DateTime) |
Extracts a day of the week from the defined DateTime. |
GetDayOfWeek([Period Finish]) |
|
GetDayOfYear(DateTime) |
Extracts a day of the year from the defined DateTime. |
GetDayOfYear([Period Finish]) |
|
GetHour(DateTime) |
Extracts an hour from the defined DateTime. |
GetHour([Period Start]) |
|
GetMilliSecond(DateTime) |
Extracts milliseconds from the defined DateTime. |
GetMilliSecond([Period Start]) |
|
GetMinute(DateTime) |
Extracts minutes from the defined DateTime. |
GetMinute([Period Start]) |
|
GetMonth(DateTime) |
Extracts a month from the defined DateTime. |
GetMonth([Period Start]) |
|
GetSecond(DateTime) |
Extracts seconds from the defined DateTime. |
GetSecond([Period Start]) |
|
GetTimeOfDay(DateTime) |
Extracts the time of the day from the defined DateTime in ticks. |
GetTimeOfDay([Period Start]) |
|
GetYear(DateTime) |
Extracts a year from the defined DateTime. |
GetYear([Period Start]) |
|
IsApril(DateTime) |
Returns True if the specified date falls within April. |
IsApril([Period Finish]) |
|
IsAugust(DateTime) |
Returns True if the specified date falls within August. |
IsAugust([Period Finish]) |
|
IsDecember(DateTime) |
Returns True if the specified date falls within December. |
IsDecember([Period Finish]) |
|
IsFebruary(DateTime) |
Returns True if the specified date falls within February. |
IsFebruary([Period Finish]) |
|
IsJanuary(DateTime) |
Returns True if the specified date falls within January. |
IsJanuary([Period Finish]) |
|
IsJuly(DateTime) |
Returns True if the specified date falls within July. |
IsJuly([Period Finish]) |
|
IsJune(DateTime) |
Returns True if the specified date falls within June. |
IsJune([Period Finish]) |
|
IsLastMonth(DateTime) |
Returns True if the specified date falls within the previous month. |
IsLastMonth([Period Finish]) |
|
IsLastYear(DateTime) |
Returns True if the specified date falls within the previous year. |
IsLastYear([Period Finish]) |
|
IsMarch(DateTime) |
Returns True if the specified date falls within March. |
IsMarch([Period Finish]) |
|
IsMay(DateTime) |
Returns True if the specified date falls within May. |
IsMay([Period Finish]) |
|
IsNextMonth(DateTime) |
Returns True if the specified date falls within the next month. |
IsNextMonth([Period Finish]) |
|
IsNextYear(DateTime) |
Returns True if the specified date falls within the next year. |
IsNextYear([Period Finish]) |
|
IsNovember(DateTime) |
Returns True if the specified date falls within November. |
IsNovember([Period Finish]) |
|
IsOctober(DateTime) |
Returns True if the specified date falls within October. |
IsOctober([Period Finish]) |
|
IsSameDay(DateTime) |
Returns True if the specified date/time values fall within the same day. |
IsSameDay([Period Finish]) |
|
IsSeptember(DateTime)` |
Returns True if the specified date falls within September. |
IsSeptember([Period Finish]) |
|
IsThisMonth(DateTime) |
Returns True if the specified date falls within the current month. |
IsThisMonth([Period Finish]) |
|
IsThisWeek(DateTime) |
Returns True if the specified date falls within the current week. |
IsThisWeek([Period Finish]) |
|
IsYearToDate(DateTime) |
Returns True if the specified date falls within the year-to-date period. This period starts from the first day of the current year and continues to the current date (including the current date). |
IsYearToDate([Period Finish]) |
|
IsThisYear(DateTime) |
Returns True if the specified date falls within the current year. |
IsThisYear([Period Finish]) |
|
LocalDateTimeDayAfterTomorrow() |
Returns a date-time value corresponding to the day after Tomorrow. |
AddDays(LocalDateTimeDayAfterTomorrow(), 5) |
|
LocalDateTimeLastMonth() |
Returns the DateTime value corresponding to the first day of the previous month. |
AddMonths(LocalDateTimeLastMonth(), 5) |
|
LocalDateTimeLastWeek() |
Returns a date-time value corresponding to the first day of the previous week. |
AddDays(LocalDateTimeLastWeek(), 5) |
|
LocalDateTimeLastYear |
Returns the DateTime value corresponding to the first day of the previous year. |
AddYears(LocalDateTimeLastYear(), 5) |
|
LocalDateTimeNextMonth() |
Returns a date-time value corresponding to the first day of the next month. |
AddMonths(LocalDateTimeNextMonth(), 5) |
|
LocalDateTimeNextWeek() |
Returns a date-time value corresponding to the first day of the following week. |
AddDays(LocalDateTimeNextWeek(), 5) |
|
LocalDateTimeNextYear() |
Returns a date-time value corresponding to the first day of the following year. |
AddYears(LocalDateTimeNextYear(), 5) |
|
LocalDateTimeNow() |
Returns a date-time value corresponding to the current moment in time. |
AddDays(LocalDateTimeNow(), 5) |
|
LocalDateTimeThisMonth() |
Returns a date-time value corresponding to the first day of the current month. |
AddMonths(LocalDateTimeThisMonth(), 5) |
|
LocalDateTimeThisWeek() |
Returns a date-time value corresponding to the first day of the current week. |
AddDays(LocalDateTimeThisWeek(), 5) |
|
LocalDateTimeThisYear() |
Returns a date-time value corresponding to the first day of the current year. |
AddYears(LocalDateTimeThisYear(), 5) |
|
LocalDateTimeToday() |
Returns a date-time value corresponding to Today. |
AddDays(LocalDateTimeToday(), 5) |
|
LocalDateTimeTomorrow() |
Returns a date-time value corresponding to Tomorrow. |
AddDays(LocalDateTimeTomorrow(), 5) |
|
LocalDateTimeTwoMonthsAway() |
Returns the DateTime value corresponding to the first day of the following month. |
AddMonths(LocalDateTimeTwoMonthAway(), 5) |
|
LocalDateTimeTwoWeeksAway |
Returns the DateTime value corresponding to the first day of the following week. |
AddDays(LocalDateTimeTwoWeeksAway(), 5) |
|
LocalDateTimeTwoYearsAway() |
Returns the DateTime value corresponding to the first day of the following year. |
AddYears(LocalDateTimeTwoYearsAway(), 5) |
|
LocalDateTimeYearBeforeToday() |
Returns the DateTime value corresponding to the day one year ago. |
AddYears(LocalDateTimeYearBeforeToday(), 5) |
|
LocalDateTimeYesterday() |
Returns a date-time value corresponding to Yesterday. |
AddDays(LocalDateTimeYesterday(), 5) |
|
Now() |
Returns the current system date and time. |
AddDays(Now(), 5) |
|
Today() |
Returns the current date. Regardless of the actual time, this function returns midnight of the current date. |
AddMonths(Today(), 1) |
|
UtcNow() |
Returns the current system date and time, expressed as Coordinated Universal Time (UTC). |
AddDays(UtcNow(), 7) |
|
Logical Functions |
Description |
Example |
|---|---|---|
|
IsNull(Value) |
Returns True if the specified Value is NULL. |
IsNull([Density]) |
|
IsNull(Value1, Value2) |
Returns the second operand if the first operand is null, otherwise, the first operand is returned. |
IsNull([Density],2.2) |
|
IsNullOrEsmpty(String) |
Returns True if the specified String object is NULL or an empty string; otherwise, False is returned. |
IsNullOrEmpty |
|
Iif(, , ) |
Iif(Expression, TruePart, FalsePart) Returns either TruePart or FalsePart, depending on the evaluation of the Boolean Expression. |
Iif([Cycle Time] < 20,"short","long" ) |
|
Math Functions |
Description |
Example |
|---|---|---|
|
Abs(Value) |
Returns the given numeric expression's absolute, positive value. |
Abs(1 - [Value]) |
|
Acos(Value) |
Returns a number's arccosine (the angle in radians, whose cosine is the given float expression). |
Acos([Value]) |
|
Asin(Value) |
Returns a number's arcsine (the angle in radians, whose sine is the given float expression). |
Asin([Value]) |
|
Atn(Value) |
Returns a number's arctangent (the angle in radians, whose tangent is the given float expression). |
Atn([Value]) |
|
Atn2(Value1, Value2) |
Returns the angle whose tangent is the quotient of two specified numbers in radians. |
Atn2([Value1], [Value2]) |
|
BigMul(Value1, Value2) |
Returns an Int64 containing the full product of two specified 32-bit numbers. |
BigMul([Valuse1], [Value2]) |
|
Ceiling(Value) |
Returns the smallest integer that is greater than or equal to the numeric expression. |
Ceiling([Value]) |
|
Cos(Value) |
Returns the angle's cosine, in radians. |
Cos([Value]) |
|
Cosh(Value) |
Returns the angle's hyperbolic cosine, in radians. |
Cosh([Value]) |
|
Exp(Value) |
Returns the float expression's exponential value. |
Exp([Value]) |
|
Floor(Value) |
Returns the largest integer less than or equal to the numeric expression. |
Floor([Value]) |
|
Log(Value) |
Returns a specified number's natural logarithm. |
Log([Value]) |
|
Log(Value, Base) |
Returns the logarithm of a specified number in a specified Base. |
Log([Value], 2) |
|
Log10(Value) |
Returns a specified number's base 10 logarithm. |
Log10([Value]) |
|
Max(Value1, Value2) |
Returns the maximum value from the specified values. |
Max([Value1], [Value2]) |
|
Min(Value1, Value2) |
Returns the minimum value from the specified values. |
Min([Value1], [Value2]) |
|
Power(Value, Power) |
Returns a specified number raised to a specified power. |
Power([Value], 3) |
|
Rnd() |
Returns a random number that is less than 1, but greater than or equal to zero. |
Rnd()*100 |
|
Round(Value) |
Returns a random number that is less than 1, but greater than or equal to zero. |
Round([Value]) |
|
Round(Value, Precision) |
Rounds the given value to the nearest integer, or to a specified number of decimal places. |
Round([Value], 2) |
|
Sign(Value) |
Returns the positive (+1), zero (0), or negative (-1) sign of the given expression. |
Sign([Value]) |
|
Sin(Value) |
Returns the sine of the angle defined in radians. |
Sin([Value]) |
|
Sinh(Value) |
Returns the hyperbolic sine of the angle defined in radians. |
Sinh([Value]) |
|
Sqr(Value) |
Returns the square root of a given number. |
Sqr([Value]) |
|
Tan(Value) |
Returns the tangent of the angle defined in radians. |
Tan([Value]) |
|
Tanh(Value) |
Returns the hyperbolic tangent of the angle defined in radians. |
Tanh([Value]) |
|
ToDecimal(Value) |
Converts Value to an equivalent decimal number. |
ToDecimal([Value]) |
|
ToDouble(Value) |
Converts Value to an equivalent 64-bit double-precision floating-point number. |
ToDouble([Value]) |
|
ToFloat(Value) |
Converts Value to an equivalent 32-bit single-precision floating-point number. |
ToFloat([Value]) |
|
ToInt(Value) |
Converts Value to an equivalent 32-bit signed integer. |
ToInt([Value]) |
|
ToLong(Value) |
Converts Value to an equivalent 64-bit signed integer. |
ToLong([Value]) |
|
String Functions |
Description |
Example |
|---|---|---|
|
Ascii(String) |
Returns the ASCII code value of the leftmost character in a character expression. |
Ascii('a') |
|
Char(Number) |
Converts an integerASCIICode to a character. |
Char(65) + Char(51) |
|
CharIndex(String1, String2) |
Returns the starting position of String1 within String2, beginning from the zero character position to the end of a string. |
CharIndex('West', 'PitWest') |
|
Concat(String1, ... , StringN) |
Returns a string value containing the concatenation of the current string with any additional strings. |
Concat('Pit_', ')', [Pit Name]) |
|
Contains(String1, SubString1) |
Returns True if SubString1 occurs within String1; otherwise, False is returned. |
Contains([Pit Name], 'West') |
|
EndsWith(String1, SubString1) |
Returns True if the end of String1 matches SubString1; otherwise, False is returned. |
EndsWith([Pit Name], 'West') |
|
Insert(String1, StartPosition, String2) |
Inserts String2 into String1 at the position specified by StartPositon |
Insert([Pit Name], 0, 'Pit_') |
|
Len(Value) |
Returns an integer containing either the number of characters in a string or the nominal number of bytes required to store a variable. |
Len([Activity Area ]) |
|
Lower(String) |
Returns String in lowercase. |
Lower([Pit Name]) |
|
PadLeft(String, Length) |
Left-aligns the defined string's characters, padding its left side with white space characters up to a specified total length. |
PadLeft([Pit Name], 30) |
|
PadLeft(String, Length, Char) |
Left-aligns the defined string's characters, padding its left side with the specified Char up to a specified total length. |
PadLeft([Pit Name], 30, '<') |
|
PadRight(String, Length) |
Right-aligns the defined string’s characters, padding its left side with empty space characters up to a specified total length. |
PadRight([Pit Name], 30) |
|
PadRight(String, Length, Char) |
Right-aligns the defined string’s characters, padding its left side with the specified Char up to a specified total length. |
PadRight([Pit Name], 30, '>') |
|
Remove(String, StartPosition) |
Deletes all the characters from this instance, beginning at a specified position. |
Remove([Pit Name], 3) |
|
Remove(String, StartPosition, Length) |
Deletes a specified number of characters from this instance, beginning at a specified position. |
Remove([Pit Name], 0, 3) |
|
Replace(String1, SubString2, String3) |
Returns a copy of String1, in which SubString2 has been replaced with String3. |
Replace([Pit Name], 'Pit', '') |
|
Reverse(String) |
Reverses the order of elements within String. |
Reverse('etucex') |
|
StartsWith(String1, SubString1) |
Returns True if the beginning of String1 matches SubString1; otherwise, False. |
StartsWith([Pit Name], 'West') |
|
Substring(String, StartPosition, Length) |
Retrieves a substring from String. The substring starts at StartPosition and has a specified Length. |
Substring([Activity Area ], 3, 6) |
|
Substring(String, StartPosition) |
Retrieves a substring from String. The substring starts at StartPosition. |
Substring([Activity Area ], 3) |
|
ToStr(Value) |
Returns a string representation of an object. |
ToStr([Mat Code]) |
|
Trim(String) |
Removes all leading and trailing SPACE characters from String. |
Trim(' a string with space at start') |
|
Upper(String) |
Returns String in upper case. |
Upper([Pit Name]) |